Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make c_s_max an input to functions #2134

Merged
merged 7 commits into from
Jun 30, 2022
Merged

Conversation

valentinsulzer
Copy link
Member

Description

Adds c_s_max as an input to some functions, instead of defining it as a parameter inside the function.
This is an attempt to split up #2073

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ flake8
  • All tests pass: $ python run-tests.py --unit
  • The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@valentinsulzer valentinsulzer changed the title fix tests make c_s_max an input to functions Jun 29, 2022
Copy link
Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@@ -1,7 +1,9 @@
from pybamm import exp, constants, Parameter


def graphite_LGM50_electrolyte_exchange_current_density_ORegan2021(c_e, c_s_surf, T):
def graphite_LGM50_electrolyte_exchange_current_density_ORegan2021(
c_e, c_s_surf, T, c_s_max
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very picky comment (and maybe quite annoying to implement). Do we want to flip T and c_s_max? This way we have electrochemical variables first, and temperature last.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, not too hard to change

@codecov
Copy link

codecov bot commented Jun 29, 2022

Codecov Report

Merging #2134 (3ebab55) into develop (7c5b44e) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop    #2134      +/-   ##
===========================================
- Coverage    99.38%   99.38%   -0.01%     
===========================================
  Files          355      355              
  Lines        19302    19279      -23     
===========================================
- Hits         19183    19160      -23     
  Misses         119      119              
Impacted Files Coverage Δ
...ectrolyte_exchange_current_density_Dualfoil1998.py 100.00% <100.00%> (ø)
...i2020/graphite_entropy_Enertech_Ai2020_function.py 100.00% <100.00%> (ø)
...s/graphite_Ai2020/graphite_volume_change_Ai2020.py 100.00% <100.00%> (ø)
...0_electrolyte_exchange_current_density_Chen2020.py 100.00% <100.00%> (ø)
...0_electrolyte_exchange_current_density_Chen2020.py 100.00% <100.00%> (ø)
..._electrolyte_exchange_current_density_Ecker2015.py 100.00% <100.00%> (ø)
...te_electrolyte_exchange_current_density_Kim2011.py 100.00% <100.00%> (ø)
...electrolyte_exchange_current_density_ORegan2021.py 100.00% <100.00%> (ø)
...n2021/graphite_LGM50_entropic_change_ORegan2021.py 100.00% <100.00%> (ø)
...ectrolyte_exchange_current_density_Ramadass2004.py 100.00% <100.00%> (ø)
... and 22 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7c5b44e...3ebab55. Read the comment docs.

@valentinsulzer valentinsulzer merged commit e5714a9 into develop Jun 30, 2022
@valentinsulzer valentinsulzer deleted the csmax-in-functions branch June 30, 2022 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants